[BETA] Get exclusive banner campaign by ID.

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "Bola-Bola Ad campaign",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exclusivityPrice": 123,
  "chargeType": "DAILY",
  "campaignType": "manual",
  "adFormat": "exclusive_banner",
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "9999-12-31T22:59:59.999999Z",
  "bidType": "exclusive",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "position": 1,
  "status": "pending",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "mediaType": "video"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

public

campaign-service

campaigns

exclusive-banner

{campaign_id}

[BETA] Get exclusive banner campaign by ID.

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner/{campaign_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "Bola-Bola Ad campaign",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exclusivityPrice": 123,
  "chargeType": "DAILY",
  "campaignType": "manual",
  "adFormat": "exclusive_banner",
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "9999-12-31T22:59:59.999999Z",
  "bidType": "exclusive",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "position": 1,
  "status": "pending",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "mediaType": "video"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

campaign_id

string<uuid>

required

The ID of the campaign to be fetched.

Response

Successful Response

Model that represents an Exclusive Banner Campaign.

name

string

required

The name of the campaign.

Minimum string length: 1

Example:

"Bola-Bola Ad campaign"

marketplaceId

string<uuid>

required

The ID of the marketplace.

campaignId

string<uuid>

required

The ID of the campaign.

exclusivityPrice

integer

required

The price to pay daily for the campaign to run.

chargeType

enum<string>

required

How exclusive campaigns are going to be charged, only daily is allowed.

Available options:

DAILY

campaignType

enum<string>

required

The bidding method for the campaign.

Available options:

manual,

autobidding,

exclusive

adFormat

string

required

The ad format of the campaign. Can be exclusive_banner.

Allowed value: "exclusive_banner"

Example:

"exclusive_banner"

vendorId

string

required

The marketplace's ID of the vendor.

walletId

string<uuid>

required

The uuid of the wallet to be used with this campaign.

isActive

boolean

default:true

Whether the campaign should be activated upon creation.The campaign will start when this is set and the start_date has passed.

externalCampaignId

string | null

The external ID of the campaign in the marketplace.

isAutoTrigger

boolean

default:false

Whether the campaign is auto-triggered.

startDate

string<date-time>

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.If the start date is in the past, it will be set to the current date.

endDate

string<date-time>

default:9999-12-31T22:59:59.999999Z

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

bidType

string

default:exclusive

The bidding type of the campaign.

Allowed value: "exclusive"

createdBy

string<uuid> | null

The ID of the user creating the campaign.

position

integer

default:1

The rank the ad will have in the auction

Required range: 1 <= x <= 20

status

enum<string>

default:pending

For an exclusive banner campaign, its initial review status.

Available options:

approved,

pending,

rejected

impressionsThreshold

integer | null

Impressions allowed for the campaign before it is stopped.

exclusivityPercentage

number | null

Percentage of auctions the campaign will be exclusive in.

mediaType

enum<string> | null

Optional media type for banner campaigns. Set to video to allow the campaign to receive video events. Omit for standard image banners.

Available options:

video

General

Auction examples

Webhook examples

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

Placement API

Export API

API Reference

[BETA] Get exclusive banner campaign by ID.

Authorizations

Path Parameters

Response